Benutzeranleitung für DBUtils
+++++++++++++++++++++++++++++

:Version: 1.1
:Released: 08/14/11
:Translations: English_ German

.. _English: UsersGuide.html

.. contents:: Inhalt


Zusammenfassung
===============

DBUtils_ ist eine Sammlung von Python-Modulen, mit deren Hilfe man in Python_
geschriebene Multithread-Anwendungen auf sichere und effiziente Weise an
Datenbanken anbinden kann. DBUtils wurde mit Blick auf `Webware for Python`_
als Anwendung und PyGreSQL_ als PostgreSQL_-Datenbankadapter entwickelt,
kann aber für beliebige Python-Anwendungen und beliebige auf `DB-API 2`_
beruhende Python-Datenbankadapter verwendet werden.


Module
======

DBUtils ist als Python-Package realisiert worden, das aus zwei verschiedenen
Gruppen von Modulen besteht: Einer Gruppe zur Verwendung mit beliebigen
DB-API-2-Datenbankadaptern, und einer Gruppe zur Verwendung mit dem klassischen PyGreSQL-Datenbankadapter-Modul.

+-------------------+----------------------------------------------+
| Allgemeine Variante für beliebige DB-API-2-Adapter               |
+===================+==============================================+
| SteadyDB.py       | Gehärtete DB-API-2-Datenbankverbindungen     |
+-------------------+----------------------------------------------+
| PooledDB.py       | Pooling für DB-API-2-Datenbankverbindungen   |
+-------------------+----------------------------------------------+
| PersistentDB.py   | Persistente DB-API-2-Datenbankverbindungen   |
+-------------------+----------------------------------------------+
| SimplePooledDB.py | Einfaches Pooling für DB-API 2               |
+-------------------+----------------------------------------------+

+-------------------+----------------------------------------------+
| Variante speziell für den klassischen PyGreSQL-Adapter           |
+===================+==============================================+
| SteadyPg.py       | Gehärtete klassische PyGreSQL-Verbindungen   |
+-------------------+----------------------------------------------+
| PooledPg.py       | Pooling für klassische PyGreSQL-Verbindungen |
+-------------------+----------------------------------------------+
| PersistentPg.py   | Persistente klassische PyGreSQL-Verbindungen |
+-------------------+----------------------------------------------+
| SimplePooledPg.py | Einfaches Pooling für klassisches PyGreSQL   |
+-------------------+----------------------------------------------+

Die Abhängigkeiten der Module in der Variante für beliebige DB-API-2-Adapter
sind im folgenden Diagramm dargestellt:

.. image:: dbdep.gif

Die Abhängigkeiten der Module in der Variante für den klassischen
PyGreSQL-Adapter sehen ähnlich aus:

.. image:: pgdep.gif


Download
========

Die aktuelle Version von DBUtils kann von der Homepage von Webware for Python
heruntergeladen werden:

  http://www.webwareforpython.org/downloads/DBUtils/

Außerdem befindet sie sich im Python Package Index (auch bekannt als der
"Cheese Shop") und kann von dort heruntergeladen werden:

  http://www.python.org/pypi/DBUtils/


Installation
============

Installation als eigenständiges Paket
-------------------------------------
Wenn Sie DBUtils für andere Anwendungen als Webware for Python verwenden
möchten, empfiehlt es sich, das Paket auf die übliche Weise zu installieren::

  python setup.py install

Installation als Unterpaket (Plug-In) von Webware for Python
------------------------------------------------------------
Wenn Sie DBUtils nur als Ergänzung für das Web-Framework Webware for Python
verwenden wollen, sollten Sie DBUtils als Webware-Plug-In installieren::

  python setup.py install --install-lib=/pfad/zu/Webware

Ersetzen Sie ``/pfad/zu/Webware`` hierbei durch den Pfad zum Wurzelverzeichnis
der Installation von Webware for Python. Sie müssen auch das Installationsskript
von Webware for Python laufen lassen, wenn dies noch nicht geschehen ist, oder
wenn Sie DBUtils in die Webware-Dokumentation integrieren wollen::

  cd /pfad/zu/Webware
  python install.py


Anforderungen
=============

DBUtils arbeitet mit Python_ 2.3 oder einer neueren Version von Python 2.
Die Module in der Variante für klassisches PyGreSQL benötigen PyGreSQL_
Version 3.4 oder höher, während die Module in der allgemeinen Variante
für DB-API 2 mit jedem beliebigen Python-Datenbankadapter-Modul
zusammenarbeiten, das auf `DB-API 2`_ basiert.


Funktionalität
==============

Dieser Abschnitt verwendet nur die Bezeichnungen der DB-API-2-Variante, aber
Entsprechendes gilt auch für die PyGreSQL-Variante.


SimplePooledDB
--------------
``DBUtils.SimplePooledDB`` ist eine sehr elementare Referenz-Implementierung
eines Pools von Datenbankverbindungen. Hiermit ist ein Vorratsspeicher an
Datenbankverbindungen gemeint, aus dem sich die Python-Anwendung bedienen kann.
Diese Implementierung ist weit weniger ausgefeilt als das eigentliche
``PooledDB``-Modul und stellt insbesondere keine Ausfallsicherung zur Verfügung.
``DBUtils.SimplePooledDB`` ist im Wesentlichen identisch mit dem zu Webware for
Python gehörenden Modul ``MiscUtils.DBPool``. Es ist eher zur Verdeutlichung
des Konzepts gedacht, als zum Einsatz im produktiven Betrieb.

SteadyDB
--------
``DBUtils.SteadyDB`` ist ein Modul, das "gehärtete" Datenbankverbindungen
bereitstellt, denen gewöhnlichen Verbindungen eines DB-API-2-Datenbankadapters
zugrunde liegen. Eine "gehärtete" Verbindung wird bei Zugriff automatisch,
ohne dass die Anwendung dies bemerkt, wieder geöffnet, wenn sie geschlossen
wurde, die Datenbankverbindung unterbrochen wurde, oder wenn sie öfter als
ein optionales Limit genutzt wurde.

Ein typisches Beispiel wo dies benötig wird, ist, wenn die Datenbank neu
gestartet wurde, während Ihre Anwendung immer noch läuft und Verbindungen
zur Datenbank offen hat, oder wenn Ihre Anwendung auf eine entfernte Datenbank
über ein Netzwerk zugreift, das durch eine Firewall geschützt ist, und die
Firewall neu gestartet wurde und dabei ihren Verbindungsstatus verloren hat.

Normalerweise benutzen Sie das ``SteadyDB``-Modul nicht direkt; es wird aber
von den beiden nächsten Modulen benötigt, ``PersistentDB`` und ``PooledDB``.

PersistentDB
------------
``DBUtils.PersistentDB`` stellt gehärtete,  thread-affine, persistente
Datenbankverbindungen zur Verfügung, unter Benutzung eines beliebigen
DB-API-2-Datenbankadapters. Mit "thread-affin" und "persistent" ist
hierbei gemeint, dass die einzelnen Datenbankverbindungen den jeweiligen
Threads fest zugeordnet bleiben und während der Laufzeit des Threads nicht
geschlossen werden.

Das folgende Diagramm zeigt die beteiligten Verbindungsschichten, wenn Sie
``PersistentDB``-Datenbankverbindungen einsetzen:

.. image:: persist.gif

Immer wenn ein Thread eine Datenbankverbindung zum ersten Mal öffnet, wird
eine neue Datenbankverbindung geöffnet, die von da an immer wieder für genau
diesen Thread verwendet wird. Wenn der Thread die Datenbankverbindung schließt,
wird sie trotzdem weiter offen gehalten, damit beim nächsten Mal, wenn der
gleiche Thread wieder eine Datenbankverbindung anfordert, diese gleiche bereits
geöffnete Datenbankverbindung wieder verwendet werden kann. Die Verbindung wird
automatisch geschlossen, wenn der Thread beendet wird.

Kurz gesagt versucht ``PersistentDB`` Datenbankverbindungen wiederzuverwerten,
um die Gesamteffizienz der Datenbankzugriffe Ihrer Multithread-Anwendungen zu
steigern, aber es wird dabei sichergestellt, dass verschiedene Threads niemals
die gleiche Verbindung benutzen.

Daher arbeitet ``PersistentDB`` sogar dann problemlos, wenn der zugrunde
liegende DB-API-2-Datenbankadapter nicht thread-sicher auf der Verbindungsebene
ist, oder wenn parallele Threads Parameter der Datenbank-Sitzung verändern
oder Transaktionen mit mehreren SQL-Befehlen durchführen.

PooledDB
--------
``DBUtils.PooledDB`` stellt, unter Benutzung eines beliebigen
DB-API-2-Datenbankadapters, einen Pool von gehärteten, thread-sicheren
Datenbankverbindungen zur Verfügung, die automatisch, ohne dass die Anwendung
dies bemerkt, wiederverwendet werden.

Das folgende Diagramm zeigt die beteiligten Verbindungsschichten, wenn Sie
``PooledDB``-Datenbankverbindungen einsetzen:

.. image:: pool.gif

Wie im Diagramm angedeutet, kann ``PooledDB`` geöffnete Datenbankverbindungen
den verschiedenen Threads beliebig zuteilen. Dies geschieht standardmäßig, wenn
Sie den Verbindungspool mit einem positiven Wert für ``maxshared`` einrichten
und der zugrunde liegende DB-API-2-Datenbankadapter auf der Verbindungsebene
thread-sicher ist, aber sie können auch dedizierte Datenbankverbindungen
anfordern, die nicht von anderen Threads verwendet werden sollen. Neben dem
Pool gemeinsam genutzter Datenbankverbindungen ("shared pool") können Sie auch
einen Pool von mindestens ``mincached`` und höchstens ``maxcached`` inaktiven
Verbindungen auf Vorrat einrichten ("idle pool"), aus dem immer dann geschöpft
wird, wenn ein Thread eine dedizierte Datenbankverbindung anfordert, oder wenn
der Pool gemeinsam genutzter Datenbankverbindungen noch nicht voll ist.
Wenn ein Thread eine Datenbankverbindung schließt, die auch von keinem anderen
Thread mehr benutzt wird, wird sie an den Vorratsspeicher inaktiver
Datenbankverbindungen zurückgegeben, damit sie wiederverwertet werden kann.

Wenn der zugrunde liegende DB-API-Datenbankadapter nicht thread-sicher ist,
werden Thread-Locks verwendet, um sicherzustellen, dass die
``PooledDB``-Verbindungen dennoch thread-sicher sind. Sie brauchen sich also
hierum keine Sorgen zu machen, aber Sie sollten darauf achten, dedizierte
Datenbankverbindungen zu verwenden, sobald Sie Parameter der Datenbanksitzung
verändern oder Transaktionen mit mehreren SQL-Befehlen ausführen.

Die Qual der Wahl
-----------------
Sowohl ``PersistentDB`` als auch ``PooledDB`` dienen dem gleichen Zweck,
nämlich die Effizienz des Datenbankzugriffs durch Wiederverwendung von
Datenbankverbindungen zu steigern, und dabei gleichzeitig die Stabilität
zu gewährleisten, selbst wenn die Datenbankverbindung unterbrochen wird.

Welches der beiden Module sollte also verwendet werden? Nach den obigen
Erklärungen ist es klar, dass ``PersistentDB`` dann sinnvoller ist, wenn
Ihre Anwendung eine gleich bleibende Anzahl Threads verwendet, die häufig
auf die Datenbank zugreifen. In diesem Fall werden Sie ungefähr die gleiche
Anzahl geöffneter Datenbankverbindungen erhalten. Wenn jedoch Ihre Anwendung
häufig Threads beendet und neu startet, dann ist ``PooledDB`` die bessere
Lösung, die auch mehr Möglichkeiten zur Feineinstellung zur Verbesserung
der Effizienz erlaubt, insbesondere bei Verwendung eines thread-sicheren
DB-API-2-Datenbankadapters.

Da die Schnittstellen beider Module sehr ähnlich sind, können Sie recht einfach
von einem Modul zum anderen wechseln und austesten, welches geeigneter ist.


Benutzung
=========

Die Benutzung aller Module ist zwar recht ähnlich, aber es gibt vor allem bei
der Initialisierung auch einige Unterschiede, sowohl zwischen den "Pooled"-
und den "Persistent"-Varianten, als auch zwischen den DB-API-2- und den
PyGreSQL-Varianten.

Wir werden hier nur auf das ``PersistentDB``-Modul und das etwas kompliziertere
``PooledDB``-Modul eingehen. Einzelheiten zu den anderen Modulen finden Sie
in deren Docstrings. Unter Verwendung der Python-Interpreter-Konsole können Sie
sich die Dokumentation des ``PooledDB``-Moduls wie folgt anzeigen lassen (dies
funktioniert entsprechend auch mit den anderen Modulen)::

  help(PooledDB)

PersistentDB
------------
Wenn Sie das ``PersistentDB``-Modul einsetzen möchten, müssen Sie zuerst einen
Generator für die von Ihnen gewünschte Art von Datenbankverbindungen einrichten,
indem Sie eine Instanz der Klasse ``PersistentDB`` erzeugen, wobei Sie folgende
Parameter angeben müssen:

* ``creator``: entweder eine Funktion, die neue DB-API-2-Verbindungen
  erzeugt, oder ein DB-API-2-Datenbankadapter-Modul

* ``maxusage``: Obergrenze dafür, wie oft eine einzelne Verbindung
  wiederverwendet werden darf (der Standardwert ``0`` oder ``None``
  bedeutet unbegrenzte Wiederverwendung)

  Sobald diese Obergrenze erreicht wird, wird die Verbindung zurückgesetzt.

* ``setsession``: eine optionale Liste von SQL-Befehlen zur Initialisierung
  der Datenbanksitzung, z.B. ``["set datestyle to german", ...]``

* ``failures``: eine optionale Exception-Klasse oder ein Tupel von Exceptions
  bei denen die Ausfallsicherung zum Tragen kommen soll, falls die Vorgabe
  (OperationalError, InternalError) nicht geeignet sein sollte

* ``ping``: mit diesem Parameter kann eingestellt werden, wann Verbindungen
  mit der ``ping()``-Methode geprüft werden, falls eine solche vorhanden ist
  (``0`` = ``None`` = nie, ``1`` = Standardwert = immer wenn neu angefragt,
  ``2`` = vor Erzeugen eines Cursors, ``4`` = vor dem Ausführen von Abfragen,
  ``7`` = immer, und alle Bitkombinationen dieser Werte)

* ``closeable``: wenn dies auf ``True`` gesetzt wird, dann wird das Schließen
  von Verbindungen erlaubt, normalerweise wird es jedoch ignoriert

* ``threadlocal``: eine optionale Klasse zur Speicherung thread-lokaler Daten,
  die anstelle unserer Python-Implementierung benutzt wird (threading.local
  ist schneller, kann aber nicht in allen Fällen verwendet werden)

* Die als ``creator`` angegebene Funktion oder die Funktion ``connect``
  des DB-API-2-Datenbankadapter-Moduls erhalten alle weiteren Parameter,
  wie ``host``, ``database``, ``user``, ``password`` usw. Sie können einige
  oder alle dieser Parameter in Ihrer eigenen ``creator``-Funktion setzen, was
  ausgefeilte Mechanismen zur Ausfallsicherung und Lastverteilung ermöglicht.

Wenn Sie beispielsweise ``pgdb`` als DB-API-2-Datenbankadapter verwenden, und
möchten, dass jede Verbindung Ihrer lokalen Datenbank ``meinedb`` 1000 mal
wiederverwendet werden soll, sieht die Initialisierung so aus::

  import pgdb # importiere das verwendete DB-API-2-Modul
  from DBUtils.PersistentDB import PersistentDB
  persist = PersistentDB(pgdb, 1000, database='meinedb')

Nachdem Sie den Generator mit diesen Parametern eingerichtet haben, können
Sie derartige Datenbankverbindungen von da an wie folgt anfordern::

  db = persist.connection()

Sie können diese Verbindungen verwenden, als wären sie gewöhnliche
DB-API-2-Datenbankverbindungen. Genauer genommen erhalten Sie die
"gehärtete" ``SteadyDB``-Version der zugrunde liegenden DB-API-2-Verbindung.

Wenn Sie eine solche persistente Verbindung mit ``db.close()`` schließen,
wird dies stillschweigend ignoriert, denn sie würde beim nächsten Zugriff
sowieso wieder geöffnet, und das wäre nicht im Sinne persistenter Verbindungen.
Stattdessen wird die Verbindung automatisch dann geschlossen, wenn der Thread
endet. Sie können dieses Verhalten ändern, indem Sie den Parameter namens
``closeable`` setzen.

Bitte beachten Sie, dass Transaktionen explizit durch Aufruf der Methode
``begin()`` eingeleiten werden müssen. Hierdurch wird sichergestellt, dass
das transparente Neueröffnen von Verbindungen bis zum Ende der Transaktion
ausgesetzt wird, und dass die Verbindung zurückgerollt wird, before sie vom
gleichen Thread erneut benutzt wird.

Das Holen einer Verbindung kann etwas beschleunigt werden, indem man den
Parameter ``threadlocal`` auf ``threading.local`` setzt; dies könnte aber in
einigen Umgebungen nicht funktionieren (es ist zum Beispiel bekannt, dass
``mod_wsgi`` hier Probleme bereitet, da es Daten, die mit ``threading.local``
gespeichert wurden, zwischen Requests löscht).

PooledDB
--------
Wenn Sie das ``PooledDB``-Modul einsetzen möchten, müssen Sie zuerst einen
Pool für die von Ihnen gewünschte Art von Datenbankverbindungen einrichten,
indem Sie eine Instanz der Klasse ``PooledDB`` erzeugen, wobei Sie folgende
Parameter angeben müssen:

* ``creator``: entweder eine Funktion, die neue DB-API-2-Verbindungen
  erzeugt, oder ein DB-API-2-Datenbankadapter-Modul

* ``mincached`` : die anfängliche Anzahl inaktiver Verbindungen, die auf
  Vorrat gehalten werden sollen (der Standardwert ``0`` bedeutet, dass beim
  Start keine Verbindungen geöffnet werden)

* ``maxcached``: Obergrenze für die Anzahl inaktiver Verbindungen, die auf
  Vorrat gehalten werden sollen (der Standardwert ``0`` oder ``None`` bedeutet
  unbegrenzte Größe des Vorratsspeichers)

* ``maxshared``: Obergrenze für die Anzahl gemeinsam genutzer Verbindungen
  (der Standardwert ``0`` oder ``None`` bedeutet, dass alle Verbindungen
  dediziert sind)

  Wenn diese Obergrenze erreicht wird, werden Verbindungen wiederverwendet,
  wenn diese als wiederverwendbar angefordert werden.

* ``maxconnections``: Obergrenze für die Anzahl an Datenbankverbindungen,
  die insgesamt überhaupt erlaubt werden sollen (der Standardwert ``0``
  oder ``None`` bedeutet unbegrenzte Anzahl von Datenbankverbindungen)

* ``blocking``: bestimmt das Verhalten bei Überschreitung dieser Obergrenze

  Wenn dies auf ``True`` gesetzt wird, dann wird so lange gewartet, bis die
  Anzahl an Datenbankverbindungen wieder abnimmt, normalerweise wird jedoch
  sofort eine Fehlermeldung ausgegeben.

* ``maxusage``: Obergrenze dafür, wie oft eine einzelne Verbindung
  wiederverwendet werden darf (der Standardwert ``0`` oder ``None``
  bedeutet unbegrenzte Wiederverwendung)

  Sobald diese Obergrenze erreicht wird, wird die Verbindung automatisch
  zurückgesetzt (geschlossen und wieder neu geöffnet).

* ``setsession``: eine optionale Liste von SQL-Befehlen zur Initialisierung
  der Datenbanksitzung, z.B. ``["set datestyle to german", ...]``

* ``reset``: wie Verbindungen zurückgesetzt werden sollen, bevor sie wieder
  in den Verbindungspool zurückgegeben werden (``False`` oder ``None``
  um mit ``begin()`` gestartete Transaktionen zurückzurollen, der Standardwert
  ``True`` rollt sicherheitshalber mögliche Transaktionen immer zurück)

* ``failures``: eine optionale Exception-Klasse oder ein Tupel von Exceptions
  bei denen die Ausfallsicherung zum Tragen kommen soll, falls die Vorgabe
  (OperationalError, InternalError) nicht geeignet sein sollte

* ``ping``: mit diesem Parameter kann eingestellt werden, wann Verbindungen
  mit der ``ping()``-Methode geprüft werden, falls eine solche vorhanden ist
  (``0`` = ``None`` = nie, ``1`` = Standardwert = immer wenn neu angefragt,
  ``2`` = vor Erzeugen eines Cursors, ``4`` = vor dem Ausführen von Abfragen,
  ``7`` = immer, und alle Bitkombinationen dieser Werte)

* Die als ``creator`` angegebene Funktion oder die Funktion ``connect``
  des DB-API-2-Datenbankadapter-Moduls erhalten alle weiteren Parameter,
  wie ``host``, ``database``, ``user``, ``password`` usw. Sie können einige
  oder alle dieser Parameter in Ihrer eigenen ``creator``-Funktion setzen, was
  ausgefeilte Mechanismen zur Ausfallsicherung und Lastverteilung ermöglicht.

Wenn Sie beispielsweise ``pgdb`` als DB-API-2-Datenbankadapter benutzen,
und einen Pool von mindestens fünf Datenbankverbindungen zu Ihrer Datenbank
``meinedb`` verwenden möchten, dann sieht die Initialisierung so aus::

  import pgdb # importiere das verwendete DB-API-2-Modul
  from DBUtils.PooledDB import PooledDB
  pool = PooledDB(pgdb, 5, database='meinedb')

Nachdem Sie den Pool für Datenbankverbindungen so eingerichtet haben, können
Sie Verbindungen daraus wie folgt anfordern::

  db = pool.connection()

Sie können diese Verbindungen verwenden, als wären sie gewöhnliche
DB-API-2-Datenbankverbindungen. Genauer genommen erhalten Sie die
"gehärtete" ``SteadyDB``-Version der zugrunde liegenden DB-API-2-Verbindung.

Bitte beachten Sie, dass die Verbindung von anderen Threads mitgenutzt werden
kann, wenn Sie den Parameter ``maxshared`` auf einen Wert größer als Null
gesetzt haben, und der zugrunde liegende DB-API-2-Datenbankadapter dies erlaubt.
Eine dedizierte Datenbankverbindung, die garantiert nicht von anderen Threads
mitgenutzt wird, fordern Sie wie folgt an::

  db = pool.connection(shareable=False)

Stattdessen können Sie eine dedizierte Verbindung auch wie folgt erhalten::

  db = pool.dedicated_connection()

Wenn Sie die Datenbankverbindung nicht mehr benötigen, sollten Sie diese sofort
wieder mit ``db.close()`` an den Pool zurückgeben. Sie können auf die gleiche
Weise eine neue Verbindung erhalten.

*Warnung:* In einer Multithread-Umgebung benutzen Sie niemals::

  pool.connection().cursor().execute(...)

Dies würde die Datenbankverbindung zu früh zur Wiederverwendung zurückgeben,
was fatale Folgen haben könnte, wenn die Verbindungen nicht thread-sicher sind.
Stellen Sie sicher, dass die Verbindungsobjekte so lange vorhanden sind, wie
sie gebraucht werden, etwa so::

  db = pool.connection()
  cur = db.cursor()
  cur.execute(...)
  res = cur.fetchone()
  cur.close() # oder del cur
  db.close() # oder del db

Bitte beachten Sie, dass Transaktionen explizit durch Aufruf der Methode
``begin()`` eingeleiten werden müssen. Hierdurch wird sichergestellt,
dass die Verbindung nicht mehr mit anderen Threads geteilt wird, dass das
transparente Neueröffnen von Verbindungen bis zum Ende der Transaktion
ausgesetzt wird, und dass die Verbindung zurückgerollt wird, bevor sie
wieder an den Verbindungspool zurückgegeben wird.

Benutzung in Webware for Python
-------------------------------
Wenn Sie DBUtils verwenden, um von Servlets des Web-Frameworks `Webware
for Python`_ auf eine Datenbank zuzugreifen, dann müssen Sie sicherstellen,
dass die Generatoren zur Erzeugung von Datenbankverbindungen nur einmal
eingerichtet werden, wenn die Anwendung startet, und nicht jedes Mal, wenn
eine Servlet-Instanz erzeugt wird. Den hierfür nötigen Code können Sie
bei der Basis-Servlet-Klasse einfügen, dort wo das Modul oder die Klasse
initialisiert wird, oder Sie können die Funktion ``contextInitialize()``
im ``__init__.py``-Skript Ihres Anwendungskontextes verwenden.

Das zusammen mit DButils ausgelieferte Verzeichnis ``Examples`` enthält
einen Beispielkontext für Webware for Python, der eine kleine Demo-Datenbank
verwendet, um Teilnehmer an einer Seminarreihe zu verwalten (die Idee für
dieses Beispiel wurde dem Artikel "`The Python DB-API`_" von Andrew Kuchling
entnommen).

Der Beispielkontext kann konfiguriert werden, indem entweder eine Konfig-Datei
``Configs/Database.config`` angelegt wird, oder indem die Standard-Parameter
direkt im Beispielservlet ``Examples/DBUtilsExample.py`` geändert werden.
Auf diese Weise können Sie einen passenden Datenbanknutzer und sein Passwort
festlegen, sowie den zugrunde liegenden Datenbankadapter auswählen (das
klassische PyGreSQL-Modul oder irgendein DB-API-2-Modul). Wenn der Parameter
``maxcached`` vorhanden ist, verwendet das Beispielservlet die
``Pooled``-Variante, andernfalls die ``Persistent``-Variante.


Anmerkungen
===========
Wenn Sie einen der bekannten "Object-Relational Mapper" SQLObject_ oder
SQLAlchemy_ verwenden, dann benötigen Sie DBUtils nicht, denn diese haben
ihre eigenen Mechanismen zum Pooling von Datenbankverbindungen eingebaut.
Tatsächlich hat `SQLObject 2`_ (SQL-API_) das Pooling in eine separate Schicht
ausgelagert, in der Code von DBUtils verwendet wird.

Wenn Sie eine Lösung verwenden wie den Apache-Webserver mit mod_python_
oder mod_wsgi_, dann sollten Sie bedenken, dass Ihr Python-Code normalerweise
im Kontext der Kindprozesse des Webservers läuft. Wenn Sie also das
``PooledDB``-Modul einsetzen, und mehrere dieser Kindprozesse laufen, dann
werden Sie ebensoviele Pools mit Datenbankverbindungen erhalten. Wenn diese
Prozesse viele Threads laufen lassen,  dann mag dies eine sinnvoller Ansatz
sein, wenn aber diese Prozesse nicht mehr als einen Worker-Thread starten,
wie im Fall des Multi-Processing Moduls "prefork" für den Apache-Webserver,
dann sollten Sie auf eine Middleware für das Connection-Pooling zurückgreifen,
die Multi-Processing unterstützt, wie zum Beispiel pgpool_ oder pgbouncer_
für die PostgreSQL-Datenbank.


Zukunft
=======
Einige Ideen für zukünftige Verbesserungen:

* Alternativ zur Obergrenze in der Anzahl der Nutzung einer Datenbankverbindung
  könnte eine maximale Lebensdauer für die Verbindung implementiert werden.
* Es könnten Module ``MonitorDB`` und ``MonitorPg`` hinzugefügt werden, die
  in einem separaten Thread ständig den "idle pool" und eventuell auch den
  "shared pool" bzw. die persistenten Verbindungen überwachen. Wenn eine
  unterbrochene Datenbankverbindung entdeckt wird, wird diese automatisch durch
  den Monitor-Thread wiederhergestellt. Dies ist in einem Szenario sinnvoll,
  bei dem die Datenbank einer Website jede Nacht neu gestartet wird. Ohne
  den Monitor-Thread würden die Benutzer morgens eine kleine Verzögerung
  bemerken, weil erst dann die unterbrochenen Datenbankverbindungen entdeckt
  würden und sich der Pool langsam wieder neu aufbaut. Mit dem Monitor-Thread
  würde dies schon während der Nacht passieren, kurz nach der Unterbrechung.
  Der Monitor-Thread könnte auch so konfiguriert werden, dass er überhaupt
  täglich den Verbindungspool erneuert, kurz bevor die Benutzer erscheinen.
* Optional sollten Benutzung, schlechte Verbindungen und Überschreitung von
  Obergrenzen in Logs gespeichert werden können.


Fehlermeldungen und Feedback
============================
Bitte Senden Sie Fehlermeldungen, Patches und Feedback direkt an den
Autor (unter Verwendung der unten angegebenen E-Mail-Adresse).

Probleme, die Webware betreffen, können auch in der `Webware for Python
mailing list`_ diskutiert werden.


Links
=====
Einige Links zu verwandter und alternativer Software:

* DBUtils_
* Python_
* `Webware for Python`_ Framework
* Python `DB-API 2`_
* PostgreSQL_ Datenbank
* PyGreSQL_ Python-Adapter for PostgreSQL
* pgpool_ Middleware für Connection-Pooling mit PostgreSQL
* pgbouncer_ Middleware für Connection-Pooling mit PostgreSQL
* SQLObject_ Objekt-relationaler Mapper
* SQLAlchemy_ Objekt-relationaler Mapper

.. _DBUtils: http://www.webwareforpython.org/DBUtils
.. _Python: http://www.python.org
.. _Webware for Python: http://www.webwareforpython.org
.. _Webware for Python mailing list: https://lists.sourceforge.net/lists/listinfo/webware-discuss
.. _DB-API 2: http://www.python.org/dev/peps/pep-0249/
.. _The Python DB-API: http://www.linuxjournal.com/article/2605
.. _PostgresQL: http://www.postgresql.org
.. _PyGreSQL: http://www.pygresql.org
.. _SQLObject: http://www.sqlobject.org
.. _SQLObject 2: http://www.sqlobject.org/2/
.. _SQL-API: http://www.sqlobject.org/sqlapi/
.. _SQLAlchemy: http://www.sqlalchemy.org
.. _Apache: http://httpd.apache.org
.. _mod_python: http://www.modpython.org
.. _mod_wsgi: http://code.google.com/p/modwsgi/
.. _pgpool: http://pgpool.projects.postgresql.org
.. _pgbouncer: http://pgbouncer.projects.postgresql.org


Autoren
=======

:Autor: Christoph Zwerschke <cito@online.de>

:Beiträge: DBUtils benutzt Code, Anmerkungen und Vorschläge von
  Ian Bicking, Chuck Esterbrook (Webware for Python), Dan Green (DBTools),
  Jay Love, Michael Palmer, Tom Schwaller, Geoffrey Talvola,
  Warren Smith (DbConnectionPool), Ezio Vernacotola, Jehiah Czebotar,
  Matthew Harriger, Gregory Piñero und Josef van Eenbergen.


Copyright und Lizenz
====================

Copyright © 2005-2011 Christoph Zwerschke.
Alle Rechte vorbehalten.

DBUtils ist freie und quelloffene Software,
lizenziert unter der `Open Software License version 2.1`__.

__ http://www.opensource.org/licenses/osl-2.1.php
